oci-cli 3.64.1__py3-none-any.whl → 3.65.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/virtual-deployment/create.txt

@@ -1,215 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a new VirtualDeployment.
-
-
-Usage
-=====
-
-   oci service-mesh virtual-deployment create [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The OCID of the compartment.
-
---name [text]
-
-A user-friendly name. The name must be unique within the same virtual
-service and cannot be changed after creation. Avoid entering
-confidential information.
-
-Example:
-
-   My unique resource name
-
---virtual-service-id [text]
-
-The OCID of the service mesh in which this access policy is created.
-
-
-Optional Parameters
-===================
-
---access-logging [complex type]
-
-This is a complex type whose value must be valid JSON. The value can
-be provided as a string on the command line or passed in as a file
-using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---defined-tags [complex type]
-
-Defined tags for this resource. Each key is predefined and scoped to a
-namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* This is
-a complex type whose value must be valid JSON. The value can be
-provided as a string on the command line or passed in as a file using
-the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---description [text]
-
-Description of the resource. It can be changed after creation. Avoid
-entering confidential information.
-
-Example:
-
-   This is my new resource
-
---freeform-tags [complex type]
-
-Simple key-value pair that is applied without any predefined name,
-type or scope. Exists for cross-compatibility only. Example: *{“bar-
-key”: “value”}* This is a complex type whose value must be valid JSON.
-The value can be provided as a string on the command line or passed in
-as a file using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---listeners [complex type]
-
-The listeners for the virtual deployment.
-
-This option is a JSON list with items of type
-VirtualDeploymentListener.  For documentation on
-VirtualDeploymentListener please see our API reference: https://docs.
-cloud.oracle.com/api/#/en/servicemesh/20220615/datatypes/VirtualDeplo
-ymentListener. This is a complex type whose value must be valid JSON.
-The value can be provided as a string on the command line or passed in
-as a file using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---max-wait-seconds [integer]
-
-The maximum time to wait for the work request to reach the state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---service-discovery [complex type]
-
-This is a complex type whose value must be valid JSON. The value can
-be provided as a string on the command line or passed in as a file
-using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---wait-for-state [text]
-
-This operation asynchronously creates, modifies or deletes a resource
-and uses a work request to track the progress of the operation.
-Specify this option to perform the action and then wait until the work
-request reaches a certain state. Multiple states can be specified,
-returning on the first state. For example, "--wait-for-state"
-SUCCEEDED "--wait-for-state" FAILED would return on whichever
-lifecycle state is reached first. If timeout is reached, a return code
-of 2 is returned. For any other error, a return code of 1 is returned.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the work request
-has reached the state defined by "--wait-for-state". Defaults to 30
-seconds.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       virtual_service_id=$(oci service-mesh virtual-service create --compartment-id $compartment_id --mesh-id $mesh_id --name $name --query data.id --raw-output)
-
-       oci service-mesh virtual-deployment create --compartment-id $compartment_id --name $name --virtual-service-id $virtual_service_id

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/virtual-deployment/delete.txt

@@ -1,141 +0,0 @@
-"delete"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Deletes a VirtualDeployment resource by identifier.
-
-
-Usage
-=====
-
-   oci service-mesh virtual-deployment delete [OPTIONS]
-
-
-Required Parameters
-===================
-
---virtual-deployment-id [text]
-
-Unique VirtualDeployment identifier.
-
-
-Optional Parameters
-===================
-
---force
-
-Perform deletion without prompting for confirmation.
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---if-match [text]
-
-For optimistic concurrency control. In the PUT or DELETE call for a
-resource, set the *if-match* parameter to the value of the etag from a
-previous GET or POST response for that resource. The resource will be
-updated or deleted only if the etag you provide matches the resource’s
-current etag value.
-
---max-wait-seconds [integer]
-
-The maximum time to wait for the work request to reach the state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---wait-for-state [text]
-
-This operation asynchronously creates, modifies or deletes a resource
-and uses a work request to track the progress of the operation.
-Specify this option to perform the action and then wait until the work
-request reaches a certain state. Multiple states can be specified,
-returning on the first state. For example, "--wait-for-state"
-SUCCEEDED "--wait-for-state" FAILED would return on whichever
-lifecycle state is reached first. If timeout is reached, a return code
-of 2 is returned. For any other error, a return code of 1 is returned.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the work request
-has reached the state defined by "--wait-for-state". Defaults to 30
-seconds.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       virtual_service_id=$(oci service-mesh virtual-service create --compartment-id $compartment_id --mesh-id $mesh_id --name $name --query data.id --raw-output)
-
-       virtual_deployment_id=$(oci service-mesh virtual-deployment create --compartment-id $compartment_id --name $name --virtual-service-id $virtual_service_id --query data.id --raw-output)
-
-       oci service-mesh virtual-deployment delete --virtual-deployment-id $virtual_deployment_id

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/virtual-deployment/get.txt

@@ -1,103 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets a VirtualDeployment by identifier.
-
-
-Usage
-=====
-
-   oci service-mesh virtual-deployment get [OPTIONS]
-
-
-Required Parameters
-===================
-
---virtual-deployment-id [text]
-
-Unique VirtualDeployment identifier.
-
-
-Optional Parameters
-===================
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.json
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       virtual_service_id=$(oci service-mesh virtual-service create --compartment-id $compartment_id --mesh-id $mesh_id --name $name --query data.id --raw-output)
-
-       virtual_deployment_id=$(oci service-mesh virtual-deployment create --compartment-id $compartment_id --name $name --virtual-service-id $virtual_service_id --query data.id --raw-output)
-
-       oci service-mesh virtual-deployment get --virtual-deployment-id $virtual_deployment_id

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/virtual-deployment/list.txt

@@ -1,150 +0,0 @@
-"list"
-******
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Returns a list of VirtualDeployments.
-
-
-Usage
-=====
-
-   oci service-mesh virtual-deployment list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
-
-
-Optional Parameters
-===================
-
---all
-
-Fetches all pages of results. If you provide this option, then you
-cannot provide the "--limit" option.
-
---from-json [text]
-
-Provide input to this command as a JSON document from a file using the
-file://path-to/file syntax.
-
-The "--generate-full-command-json-input" option can be used to
-generate a sample json file to be used with this command option. The
-key names are pre-populated and match the command option names
-(converted to camelCase format, e.g. compartment-id –> compartmentId),
-while the values of the keys need to be populated by the user before
-using the sample file as an input to this command. For any command
-option that accepts multiple values, the value of the key can be a
-JSON array.
-
-Options can still be provided on the command line. If an option exists
-in both the JSON document and the command line then the command line
-specified value will be used.
-
-For examples on usage of this option, please see our “using CLI with
-advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---id [text]
-
-Unique VirtualDeployment identifier.
-
---lifecycle-state [text]
-
-A filter to return only resources that match the life cycle state
-given.
-
-Accepted values are:
-
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
-
---limit [integer]
-
-The maximum number of items to return.
-
---name [text]
-
-A filter to return only resources that match the entire name given.
-
---page [text]
-
-A token representing the position at which to start retrieving
-results. This must come from the *opc-next-page* header field of a
-previous response.
-
---page-size [integer]
-
-When fetching results, the number of results to fetch per call. Only
-valid when used with "--all" or "--limit", and ignored otherwise.
-
---sort-by [text]
-
-The field to sort by. Only one sort order may be provided. Default
-order for ‘timeCreated’ is descending. Default order for ‘name’ is
-ascending.
-
-Accepted values are:
-
-   id, name, timeCreated
-
---sort-order [text]
-
-The sort order to use, either ‘ASC’ or ‘DESC’.
-
-Accepted values are:
-
-   ASC, DESC
-
---virtual-service-id [text]
-
-Unique VirtualService identifier.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy the following CLI commands into a file named example.sh. Run the
-command by typing “bash example.sh” and replacing the example
-parameters with your own.
-
-Please note this sample will only work in the POSIX-compliant bash-
-like shell. You need to set up the OCI configuration and appropriate
-security policies before trying the examples.
-
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/virtual-deployment/list.html#cmdoption-compartment-id
-
-       oci service-mesh virtual-deployment list --compartment-id $compartment_id